Notification Messages

Messages are used by the Notification system to communicate site activities. You can view each activity’s default message from the Workarea > Settings > Community Management > Notifications > Messages screen.

You can edit any default message as well as create new ones.

Messages are more fully explained through these topics.

Message Types

Assigning the Default Message for a Type and Sub Type

Message Types

There are two message types:

User

Community Group

Each type contains several sub types. The sub type is the activity that triggers the message. For example, to edit the message that notifies colleagues when a user uploads a document to his Workspace, select User from the Type drop down and AddWorkspaceItem from the Sub Type drop down.

For a list of Sub types, see Notification Messages.

Assigning the Default Message for a Type and Sub Type

When you create a new message, you assign it to a type and sub type, such as User Activity > Blog Post. Only the default message is active for any combination of type and subtype.

So, while creating a new message, you must make it the default (via the Add Notification Message screen’s Default check box) if you want it to be sent.

When you do, if another message was the default for that type and sub type, it is no longer used.

Composing a Message

You can create an HTML-based and a plain text message for each activity. Typically, HTML messages are sent as email or to the ActivityStream server control, while plain text is used in SMS style messages.

Messages typically combine text and tokens. See Also: Working with Tokens

Working with Tokens

Tokens are Ektron-defined variables surrounded by at signs (@). When a message is generated, tokens retrieve information about Ektron CMS400.NET users, groups, and objects. For example, the following message:

@SubjectUser.FirstName@ added a new document, ‘@Content.title@’, to his profile page.

might look like this:

“Paul added a new document, ‘How to Write Code’, to his profile page.”

In this example, @SubjectUser.FirstName@ is the first name of the user performing the action. @Content.title@ is the title of the object that was uploaded.

Token Types

A message can include several token types.

SubjectUser tokens—represent the user who performs the activity
DirectObjectUser tokens—represent the user to which the activity is happening
Content tokens—represent the content that was a part of the activity
CommunityGroup tokens—represent the community group that was involved in the activity
Blog tokens—represent the blog use in the activity
webEvent tokens—represents the Web Calendar used in the activity**
MicroMessage tokens—represent micromessages used in the activity

The table below lists Message Sub Types and the Tokens available to each one.

Message Tokens: User and Content-Based

Message Sub Type	Associated Tokens
Add Calendar Event Update Calendar Event	@System.SiteUrl@, @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @WebEvent.Id@ @WebEvent.Title@ @WebEvent.Quicklink@ @WebEvent.StartTime@ @WebEvent.EndTime@
AddColleague	@System.SiteUrl@, @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @DirectObjectUser.Id@ @DirectObjectUser.UserName@ @SubjectUser.DisplayName@ @DirectObjectUser.FirstName@ @DirectObjectUser.LastName@ @DirectObjectUser.TemplateAlias@
AddContent	@System.SiteURL@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@
AddWorkspaceItem	@System.SiteURL@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@
BlogComment	@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @BlogComment.Id@ @BlogComment.Message@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@
BlogPost	@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@
CreateCommunityGroup	@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @CommunityGroup.Id@ @CommunityGroup.Name@ @CommunityGroup.TemplateAlias@
ContentMessageBoardPost	@System.SiteUrl@ @System.GroupProfileTemplate @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@ @MessageBoard.ObjectId@ @MessageBoard.ObjectType@ @MessageBoard.Message
EditContent	@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@
EditWorkspaceItem	@System.SiteUrl @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@
ForumReply	@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @Topic.Id@, @Topic.Title@ @Topic.Quicklink@ @TopicReply.Id@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@
ForumPost	@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @Topic.Id@, @Topic.Title@ @Topic.Quicklink@ @TopicReply.Id@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@
JoinCommunityGroup	@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @CommunityGroup.Id@ @CommunityGroup.Name@ @CommunityGroup.TemplateAlias@
MicroMessage	@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @MicroMessage.Id@ @MicroMessage.Message@
UserMessageboardPost	@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @DirectObjectUser.Id@ @DirectObjectUser.UserName@ @DirectObjectUser.FirstName@ @DirectObjectUser.LastName@ @SubjectUser.TemplateAlias@ @MessageBoard.ObjectId@ @MessageBoard.ObjectType@ @MessageBoard.Message@

Message Tokens: Community Group-Based

Message Type	Associated Tokens
Add Calendar Event Update Calendar Event	@System.SiteUrl@, @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @WebEvent.Id@ @WebEvent.Title@ @WebEvent.Quicklink@ @WebEvent.StartTime@ @WebEvent.EndTime@
AddWorkspaceItem	@System.SiteURL@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @DirectObjectUser.Id@ @DirectObjectUser.UserName@ @DirectObjectUser.FirstName@ @DirectObjectUser.LastName@ @CommunityGroup.Id@ @CommunityGroup.Name@ @Content.Id@ @Content.Title@ @Content.Quicklink@ @Content.Icon@
BlogComment	@BlogComment.Id@ @BlogComment.Message@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.FirstName@ @SubjectUser.LastName@
BlogPost	@SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @Content.Id@ @Content.Title@ @Content.Quicklink@
CreateCommunityGroup	@SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @CommunityGroup.Id@ @CommunityGroup.Name@
GroupMessageBoardPost	@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@ @SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.DisplayName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @SubjectUser.TemplateAlias@ @CommunityGroup.Id@ @CommunityGroup.Name@ @CommunityGroup.TemplateAlias@ @MessageBoard.ObjectId@ @MessageBoard.ObjectType@ @MessageBoard.Message@
JoinCommunityGroup	@SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @CommunityGroup.Id@ @CommunityGroup.Name@
UserMessageboardPost	@SubjectUser.Id@ @SubjectUser.UserName@ @SubjectUser.FirstName@ @SubjectUser.LastName@ @DirectObjectUser.Id@ @DirectObjectUser.UserName@ @DirectObjectUser.FirstName@ @DirectObjectUser.LastName@ @MessageBoard.ObjectId@ @MessageBoard.ObjectType@ @MessageBoard.Message@

Message Tokens: Email Reply Message

Message Sub Type	Associated Tokens
Email Message Reply	@System.SiteUrl@ @System.GroupProfileTemplate@ @System.UserProfileTemplate@

Making Tokens into Hyperlinks

Message tokens represent Ektron CMS400.NET users, groups and content. They can become links that, when clicked, bring the user to content, a user’s profile, or community group’s profile, as shown below.

To make tokens into clickable links, follow these steps.

1. Create the message as described in Adding a Message.

2. While editing the message text, highlight a token and click Hyperlink Manager (circled below).

3. In the URL field, enter the path to the page that displays the content, user, or community group.

Make sure you include the QueryString parameter used to identify the object. The parameter should point to an ID token. For example, a message notifies a user’s colleagues whenever he adds a new colleague. The message might be:

@SubjectUser.UserName@ and @DirectObjectUser.UserName@ are now colleagues.

When creating a link for @SubjectUser.UserName@, insert the path to the user’s profile page into the URL field. It might look like this:

http://localhost/Intranet/UserProfile.aspx?id=@subjectUser.Id@

Note, the QueryString parameter (?id=) points to a token that represents the logged-in user’s ID, @subjectUser.Id@. See Also: Token Types

For @DirectObjectUser.UserName@, enter the same path and change the dynamic parameter token to [email protected]@.

When hyperlinking content, use its QuickLink token in the path defined in the URL field. For example, a message that sends a Notification when a user adds content might look like:

@SubjectUser.username@ added new content, @Content.Title@.

4. Make sure the original token text appears in the Link Text field.

5. Click OK.

Adding a Message

Warning! A message is limited to 3000 characters after its tokens are converted to text. After 3000, any remaining characters are removed.

To create a message, follow these steps. See Also: Notification Messages

1. Log into the Workarea as an administrator.

2. Navigate to Settings > Community Management > Notifications > Messages.

3. If you are using the Multi-Site feature, select the site with which this message will be associated.

4. Click Add Notification Message ().

5. The Add Notification Message screen appears.

6. Complete the fields as described below.

Field	Description
Title	Enter a name for the message.
Type	Select the type of message you want to create. Choices are: User—message sent when user activity occurs Community Group—message sent when group activity occurs The activity is specified at the Sub Type field.
Sub Type	Select the activity which triggers the sending of this message. See Also: Message Types.
Tokens	A list of available tokens for the selected Sub Type appears. Note: To easily insert a token into a message, highlight a token, then copy and paste it into the message. For a list of tokens and their sub types with, see Message Tokens: User and Content-BasedMessage Sub TypeAssociated TokensAdd Calendar EventUpdate Calendar [email protected]@,@System.GroupProfileTemplate@ @System.UserProfileTemplate@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@ @SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@@WebEvent.Id@@WebEvent.Title@@WebEvent.Quicklink@@WebEvent.StartTime@@WebEvent.EndTime@AddColleague @System.SiteUrl@,@System.GroupProfileTemplate@ @System.UserProfileTemplate@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@@DirectObjectUser.Id@@DirectObjectUser.UserName@@SubjectUser.DisplayName@@DirectObjectUser.FirstName@@DirectObjectUser.LastName@@DirectObjectUser.TemplateAlias@AddContent @System.SiteURL@@System.GroupProfileTemplate@@System.UserProfileTemplate@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@@Content.Id@@Content.Title@@Content.Quicklink@@Content.Icon@[email protected]@@System.GroupProfileTemplate@@System.UserProfileTemplate@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@@Content.Id@@Content.Title@@Content.Quicklink@@Content.Icon@BlogComment @System.SiteUrl@@System.GroupProfileTemplate@@System.UserProfileTemplate@@BlogComment.Id@@BlogComment.Message@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@BlogPost @System.SiteUrl@@System.GroupProfileTemplate@@System.UserProfileTemplate@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@@Content.Id@@Content.Title@@Content.Quicklink@@Content.Icon@CreateCommunityGroup @System.SiteUrl@@System.GroupProfileTemplate@@System.UserProfileTemplate@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@@CommunityGroup.Id@@CommunityGroup.Name@@CommunityGroup.TemplateAlias@ContentMessageBoardPost @System.SiteUrl@@System.GroupProfileTemplate @System.UserProfileTemplate@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@@Content.Id@@Content.Title@@Content.Quicklink@ @Content.Icon@@MessageBoard.ObjectId@@MessageBoard.ObjectType@@[email protected]@@System.GroupProfileTemplate@@System.UserProfileTemplate@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@@Content.Id@@Content.Title@@Content.Quicklink@@Content.Icon@[email protected] @System.GroupProfileTemplate@@System.UserProfileTemplate@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@@Content.Id@@Content.Title@@Content.Quicklink@@Content.Icon@[email protected]@@System.GroupProfileTemplate@@System.UserProfileTemplate@@Topic.Id@, @Topic.Title@@Topic.Quicklink@@TopicReply.Id@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@[email protected]@@System.GroupProfileTemplate@@System.UserProfileTemplate@@Topic.Id@, @Topic.Title@@Topic.Quicklink@@TopicReply.Id@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@JoinCommunityGroup @System.SiteUrl@@System.GroupProfileTemplate@@System.UserProfileTemplate@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@@CommunityGroup.Id@@CommunityGroup.Name@@CommunityGroup.TemplateAlias@MicroMessage @System.SiteUrl@@System.GroupProfileTemplate@@System.UserProfileTemplate@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@SubjectUser.TemplateAlias@@MicroMessage.Id@@MicroMessage.Message@UserMessageboardPost @System.SiteUrl@@System.GroupProfileTemplate@@System.UserProfileTemplate@@SubjectUser.Id@@SubjectUser.UserName@@SubjectUser.DisplayName@@SubjectUser.FirstName@@SubjectUser.LastName@@DirectObjectUser.Id@@DirectObjectUser.UserName@@DirectObjectUser.FirstName@@DirectObjectUser.LastName@@SubjectUser.TemplateAlias@@MessageBoard.ObjectId@@MessageBoard.ObjectType@@MessageBoard.Message@. To learn about how to make tokens into hyperlinks, see Making Tokens into Hyperlinks.
Default	Click this check box if you want the message to be the default one that is sent. See Also: Assigning the Default Message for a Type and Sub Type
Subject	Enter a subject to be used if the message is sent as email.
Text	Enter the text and tokens that comprise the message. The editor allows you to format the text. Use this editor for HTML, email, and activity stream messages. See Also: Composing a Message and Making Tokens into Hyperlinks
Plain Text	Enter the text and tokens that comprise the message you want to send. Use this field for SMS type messages and messages to be sent as plain text. Note: Tip! If you already composed the message in the editor above, you can select that text, then copy and paste it into the Plain Text field. Warning! Most SMS systems impose a 160 character limit on messages. If you create a plain text message greater than 160 characters, Ektron CMS400.NET divides it into several, smaller messages.

7. Click Save ().

The message now appears in the list of Notification messages. If it is the default and an activity occurs on your Web site that matches the type and sub type, the message is sent.

Editing a Message

To edit a message, follow these steps. See Also: Notification Messages

1. Log into the Workarea as an administrator.

2. Navigate to Settings > Community Management > Notification > Messages.

3. If you are using Ektron's Multi-Site feature, select the site for which this message is used.

4. Click the title of the message you want to edit.

5. Make changes as needed. For a description of the fields on this screen, see Adding a Message.

6. Click Save ().

Removing a Message

When you no longer need a message, you can remove it from Ektron CMS400.NET. To remove a message, follow these steps.

1. Log into the Workarea as an administrator.

2. Navigate to Settings > Community Management > Notification > Messages.

3. Click the title of the message you want to delete.

4. Click Delete ().

5. Click OK on the confirmation message.

6. The message is removed.